Fingerprint 5 Device Settings

Settings for registers of Fingerprint 5 Click driver. More...

Macros
#define	FINGERPRINT5_CMD_STATUS   0x0040
	Fingerprint 5 command IDs list.
#define	FINGERPRINT5_CMD_VERSION   0x0041
#define	FINGERPRINT5_CMD_BIST   0x0044
#define	FINGERPRINT5_CMD_CAPTURE   0x0050
#define	FINGERPRINT5_CMD_ABORT   0x0052
#define	FINGERPRINT5_CMD_IMAGE_DATA   0x0053
#define	FINGERPRINT5_CMD_ENROLL   0x0054
#define	FINGERPRINT5_CMD_IDENTIFY   0x0055
#define	FINGERPRINT5_CMD_LIST_TEMPLATES   0x0060
#define	FINGERPRINT5_CMD_DELETE_TEMPLATE   0x0061
#define	FINGERPRINT5_CMD_GET_SYSTEM_CONFIG   0x006A
#define	FINGERPRINT5_CMD_SET_SYSTEM_CONFIG   0x006B
#define	FINGERPRINT5_CMD_RESET   0x0072
#define	FINGERPRINT5_CMD_SET_DBG_LOG_LEVEL   0x00B0
#define	FINGERPRINT5_CMD_DATA_GET   0x0101
#define	FINGERPRINT5_CMD_NAVIGATION   0x0200
#define	FINGERPRINT5_CMD_GPIO_CONTROL   0x0300
#define	FINGERPRINT5_FRAME_PROTOCOL_VERSION   0x0004
	Fingerprint 5 frame settings.
#define	FINGERPRINT5_FRAME_TYPE_REQUEST   0x11
#define	FINGERPRINT5_FRAME_TYPE_RESPONSE   0x12
#define	FINGERPRINT5_FRAME_TYPE_EVENT   0x13
#define	FINGERPRINT5_FRAME_FLAG_HOST   0x0010
#define	FINGERPRINT5_FRAME_FLAG_FW_BL   0x0020
#define	FINGERPRINT5_FRAME_FLAG_FW_APP   0x0040
#define	FINGERPRINT5_FRAME_CMD_MAX_DATA_SIZE   244
#define	FINGERPRINT5_FRAME_MAX_SIZE   256
#define	FINGERPRINT5_MAX_VERSION_SIZE   100
	Fingerprint 5 buffers settings.
#define	FINGERPRINT5_MAX_NUM_TEMPLATES   12
#define	FINGERPRINT5_EVENT_NONE   0
	Fingerprint 5 event settings.
#define	FINGERPRINT5_EVENT_IDLE   1
#define	FINGERPRINT5_EVENT_ARMED   2
#define	FINGERPRINT5_EVENT_FINGER_DETECT   3
#define	FINGERPRINT5_EVENT_FINGER_LOST   4
#define	FINGERPRINT5_EVENT_IMAGE_READY   5
#define	FINGERPRINT5_EVENT_CMD_FAILED   6
#define	FINGERPRINT5_STATE_APP_FW_READY   0x0001
	Fingerprint 5 stete settings.
#define	FINGERPRINT5_STATE_CAPTURE   0x0004
#define	FINGERPRINT5_STATE_IMAGE_AVAILABLE   0x0010
#define	FINGERPRINT5_STATE_DATA_TRANSFER   0x0040
#define	FINGERPRINT5_STATE_FINGER_DOWN   0x0080
#define	FINGERPRINT5_STATE_SYS_ERROR   0x0400
#define	FINGERPRINT5_STATE_ENROLL   0x1000
#define	FINGERPRINT5_STATE_IDENTIFY   0x2000
#define	FINGERPRINT5_STATE_NAVIGATION   0x4000
#define	FINGERPRINT5_TEMPLATE_ID_TYPE_NONE   0x1012
	Fingerprint 5 template ID type settings.
#define	FINGERPRINT5_TEMPLATE_ID_TYPE_ALL   0x2023
#define	FINGERPRINT5_TEMPLATE_ID_TYPE_SPECIFIED   0x3034
#define	FINGERPRINT5_TEMPLATE_ID_TYPE_NEW   0x4045
#define	FINGERPRINT5_ENROLL_FEEDBACK_DONE   1
	Fingerprint 5 enroll feedback settings.
#define	FINGERPRINT5_ENROLL_FEEDBACK_PROGRESS   2
#define	FINGERPRINT5_ENROLL_FEEDBACK_REJECT_LOW_QUALITY   3
#define	FINGERPRINT5_ENROLL_FEEDBACK_REJECT_LOW_COVERAGE   4
#define	FINGERPRINT5_ENROLL_FEEDBACK_REJECT_LOW_MOBILITY   5
#define	FINGERPRINT5_ENROLL_FEEDBACK_REJECT_OTHER   6
#define	FINGERPRINT5_ENROLL_FEEDBACK_PROGRESS_IMMOBILE   7
#define	FINGERPRINT5_IDENTIFY_RESULT_MATCH   0x61EC
	Fingerprint 5 identify match settings.
#define	FINGERPRINT5_IDENTIFY_RESULT_NO_MATCH   0xBAAD
#define	FINGERPRINT5_NAV_ORIENTATION_0   0
	Fingerprint 5 navigation orientation settings.
#define	FINGERPRINT5_NAV_ORIENTATION_90   1
#define	FINGERPRINT5_NAV_ORIENTATION_180   2
#define	FINGERPRINT5_NAV_ORIENTATION_270   3
#define	FINGERPRINT5_GPIO_SUB_CMD_GET   0
	Fingerprint 5 GPIO control settings.
#define	FINGERPRINT5_GPIO_SUB_CMD_SET   1
#define	FINGERPRINT5_GPIO_MODE_NOT_USED   0
#define	FINGERPRINT5_GPIO_MODE_OUTPUT_PP   1
#define	FINGERPRINT5_GPIO_MODE_OUTPUT_OD   2
#define	FINGERPRINT5_GPIO_MODE_INPUT_PULL_NONE   3
#define	FINGERPRINT5_GPIO_MODE_INPUT_PULL_UP   4
#define	FINGERPRINT5_GPIO_MODE_INPUT_PULL_DOWN   5
#define	FINGERPRINT5_GPIO_STATE_RESET   0
#define	FINGERPRINT5_GPIO_STATE_SET   1
#define	FINGERPRINT5_SYS_CFG_VERSION   1
	Fingerprint 5 system config settings.
#define	FINGERPRINT5_SYS_CFG_FLAG_STATUS_EVT_BOOT   0x00000001
#define	FINGERPRINT5_SYS_CFG_FLAG_UART_IN_STOP_MODE   0x00000010
#define	FINGERPRINT5_SYS_CFG_FLAG_UART_IRQ_TX   0x00000020
#define	FINGERPRINT5_SYS_CFG_UART_BAUDRATE_9600   1
#define	FINGERPRINT5_SYS_CFG_UART_BAUDRATE_19200   2
#define	FINGERPRINT5_SYS_CFG_UART_BAUDRATE_57600   3
#define	FINGERPRINT5_SYS_CFG_UART_BAUDRATE_115200   4
#define	FINGERPRINT5_SYS_CFG_UART_BAUDRATE_921600   5
#define	FINGERPRINT5_SYS_CFG_TYPE_DEFAULT   0
#define	FINGERPRINT5_SYS_CFG_TYPE_CUSTOM   1
#define	FINGERPRINT5_RX_TIMEOUT_MS   3000
	Fingerprint 5 timeout setting.
#define	FINGERPRINT5_TX_DRV_BUFFER_SIZE   256
	Fingerprint 5 driver buffer size.
#define	FINGERPRINT5_RX_DRV_BUFFER_SIZE   256
#define	FINGERPRINT5_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
	Data sample selection.
#define	FINGERPRINT5_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE

Detailed Description

Settings for registers of Fingerprint 5 Click driver.

Macro Definition Documentation

FINGERPRINT5_CMD_ABORT

#define FINGERPRINT5_CMD_ABORT   0x0052

FINGERPRINT5_CMD_BIST

#define FINGERPRINT5_CMD_BIST   0x0044

FINGERPRINT5_CMD_CAPTURE

#define FINGERPRINT5_CMD_CAPTURE   0x0050

FINGERPRINT5_CMD_DATA_GET

#define FINGERPRINT5_CMD_DATA_GET   0x0101

FINGERPRINT5_CMD_DELETE_TEMPLATE

#define FINGERPRINT5_CMD_DELETE_TEMPLATE   0x0061

FINGERPRINT5_CMD_ENROLL

#define FINGERPRINT5_CMD_ENROLL   0x0054

FINGERPRINT5_CMD_GET_SYSTEM_CONFIG

#define FINGERPRINT5_CMD_GET_SYSTEM_CONFIG   0x006A

FINGERPRINT5_CMD_GPIO_CONTROL

#define FINGERPRINT5_CMD_GPIO_CONTROL   0x0300

FINGERPRINT5_CMD_IDENTIFY

#define FINGERPRINT5_CMD_IDENTIFY   0x0055

FINGERPRINT5_CMD_IMAGE_DATA

#define FINGERPRINT5_CMD_IMAGE_DATA   0x0053

FINGERPRINT5_CMD_LIST_TEMPLATES

#define FINGERPRINT5_CMD_LIST_TEMPLATES   0x0060

FINGERPRINT5_CMD_NAVIGATION

#define FINGERPRINT5_CMD_NAVIGATION   0x0200

FINGERPRINT5_CMD_RESET

#define FINGERPRINT5_CMD_RESET   0x0072

FINGERPRINT5_CMD_SET_DBG_LOG_LEVEL

#define FINGERPRINT5_CMD_SET_DBG_LOG_LEVEL   0x00B0

FINGERPRINT5_CMD_SET_SYSTEM_CONFIG

#define FINGERPRINT5_CMD_SET_SYSTEM_CONFIG   0x006B

FINGERPRINT5_CMD_STATUS

#define FINGERPRINT5_CMD_STATUS   0x0040

Fingerprint 5 command IDs list.

Specified setting for command IDs list of Fingerprint 5 Click driver.

FINGERPRINT5_CMD_VERSION

#define FINGERPRINT5_CMD_VERSION   0x0041

FINGERPRINT5_ENROLL_FEEDBACK_DONE

#define FINGERPRINT5_ENROLL_FEEDBACK_DONE   1

Fingerprint 5 enroll feedback settings.

Specified setting for enroll feedback of Fingerprint 5 Click driver.

FINGERPRINT5_ENROLL_FEEDBACK_PROGRESS

#define FINGERPRINT5_ENROLL_FEEDBACK_PROGRESS   2

FINGERPRINT5_ENROLL_FEEDBACK_PROGRESS_IMMOBILE

#define FINGERPRINT5_ENROLL_FEEDBACK_PROGRESS_IMMOBILE   7

FINGERPRINT5_ENROLL_FEEDBACK_REJECT_LOW_COVERAGE

#define FINGERPRINT5_ENROLL_FEEDBACK_REJECT_LOW_COVERAGE   4

FINGERPRINT5_ENROLL_FEEDBACK_REJECT_LOW_MOBILITY

#define FINGERPRINT5_ENROLL_FEEDBACK_REJECT_LOW_MOBILITY   5

FINGERPRINT5_ENROLL_FEEDBACK_REJECT_LOW_QUALITY

#define FINGERPRINT5_ENROLL_FEEDBACK_REJECT_LOW_QUALITY   3

FINGERPRINT5_ENROLL_FEEDBACK_REJECT_OTHER

#define FINGERPRINT5_ENROLL_FEEDBACK_REJECT_OTHER   6

FINGERPRINT5_EVENT_ARMED

#define FINGERPRINT5_EVENT_ARMED   2

FINGERPRINT5_EVENT_CMD_FAILED

#define FINGERPRINT5_EVENT_CMD_FAILED   6

FINGERPRINT5_EVENT_FINGER_DETECT

#define FINGERPRINT5_EVENT_FINGER_DETECT   3

FINGERPRINT5_EVENT_FINGER_LOST

#define FINGERPRINT5_EVENT_FINGER_LOST   4

FINGERPRINT5_EVENT_IDLE

#define FINGERPRINT5_EVENT_IDLE   1

FINGERPRINT5_EVENT_IMAGE_READY

#define FINGERPRINT5_EVENT_IMAGE_READY   5

FINGERPRINT5_EVENT_NONE

#define FINGERPRINT5_EVENT_NONE   0

Fingerprint 5 event settings.

Specified setting for event of Fingerprint 5 Click driver.

FINGERPRINT5_FRAME_CMD_MAX_DATA_SIZE

#define FINGERPRINT5_FRAME_CMD_MAX_DATA_SIZE   244

FINGERPRINT5_FRAME_FLAG_FW_APP

#define FINGERPRINT5_FRAME_FLAG_FW_APP   0x0040

FINGERPRINT5_FRAME_FLAG_FW_BL

#define FINGERPRINT5_FRAME_FLAG_FW_BL   0x0020

FINGERPRINT5_FRAME_FLAG_HOST

#define FINGERPRINT5_FRAME_FLAG_HOST   0x0010

FINGERPRINT5_FRAME_MAX_SIZE

#define FINGERPRINT5_FRAME_MAX_SIZE   256

FINGERPRINT5_FRAME_PROTOCOL_VERSION

#define FINGERPRINT5_FRAME_PROTOCOL_VERSION   0x0004

Fingerprint 5 frame settings.

Specified setting for frame type of Fingerprint 5 Click driver.

FINGERPRINT5_FRAME_TYPE_EVENT

#define FINGERPRINT5_FRAME_TYPE_EVENT   0x13

FINGERPRINT5_FRAME_TYPE_REQUEST

#define FINGERPRINT5_FRAME_TYPE_REQUEST   0x11

FINGERPRINT5_FRAME_TYPE_RESPONSE

#define FINGERPRINT5_FRAME_TYPE_RESPONSE   0x12

FINGERPRINT5_GPIO_MODE_INPUT_PULL_DOWN

#define FINGERPRINT5_GPIO_MODE_INPUT_PULL_DOWN   5

FINGERPRINT5_GPIO_MODE_INPUT_PULL_NONE

#define FINGERPRINT5_GPIO_MODE_INPUT_PULL_NONE   3

FINGERPRINT5_GPIO_MODE_INPUT_PULL_UP

#define FINGERPRINT5_GPIO_MODE_INPUT_PULL_UP   4

FINGERPRINT5_GPIO_MODE_NOT_USED

#define FINGERPRINT5_GPIO_MODE_NOT_USED   0

FINGERPRINT5_GPIO_MODE_OUTPUT_OD

#define FINGERPRINT5_GPIO_MODE_OUTPUT_OD   2

FINGERPRINT5_GPIO_MODE_OUTPUT_PP

#define FINGERPRINT5_GPIO_MODE_OUTPUT_PP   1

FINGERPRINT5_GPIO_STATE_RESET

#define FINGERPRINT5_GPIO_STATE_RESET   0

FINGERPRINT5_GPIO_STATE_SET

#define FINGERPRINT5_GPIO_STATE_SET   1

FINGERPRINT5_GPIO_SUB_CMD_GET

#define FINGERPRINT5_GPIO_SUB_CMD_GET   0

Fingerprint 5 GPIO control settings.

Specified setting for GPIO control of Fingerprint 5 Click driver.

FINGERPRINT5_GPIO_SUB_CMD_SET

#define FINGERPRINT5_GPIO_SUB_CMD_SET   1

FINGERPRINT5_IDENTIFY_RESULT_MATCH

#define FINGERPRINT5_IDENTIFY_RESULT_MATCH   0x61EC

Fingerprint 5 identify match settings.

Specified setting for identify match of Fingerprint 5 Click driver.

FINGERPRINT5_IDENTIFY_RESULT_NO_MATCH

#define FINGERPRINT5_IDENTIFY_RESULT_NO_MATCH   0xBAAD

FINGERPRINT5_MAX_NUM_TEMPLATES

#define FINGERPRINT5_MAX_NUM_TEMPLATES   12

FINGERPRINT5_MAX_VERSION_SIZE

#define FINGERPRINT5_MAX_VERSION_SIZE   100

Fingerprint 5 buffers settings.

Specified setting for buffers of Fingerprint 5 Click driver.

FINGERPRINT5_NAV_ORIENTATION_0

#define FINGERPRINT5_NAV_ORIENTATION_0   0

Fingerprint 5 navigation orientation settings.

Specified setting for navigation orientation of Fingerprint 5 Click driver.

FINGERPRINT5_NAV_ORIENTATION_180

#define FINGERPRINT5_NAV_ORIENTATION_180   2

FINGERPRINT5_NAV_ORIENTATION_270

#define FINGERPRINT5_NAV_ORIENTATION_270   3

FINGERPRINT5_NAV_ORIENTATION_90

#define FINGERPRINT5_NAV_ORIENTATION_90   1

FINGERPRINT5_RX_DRV_BUFFER_SIZE

#define FINGERPRINT5_RX_DRV_BUFFER_SIZE   256

FINGERPRINT5_RX_TIMEOUT_MS

#define FINGERPRINT5_RX_TIMEOUT_MS   3000

Fingerprint 5 timeout setting.

Specified setting for timeout of Fingerprint 5 Click driver.

FINGERPRINT5_SET_DATA_SAMPLE_EDGE

#define FINGERPRINT5_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE

Data sample selection.

This macro sets data samples for SPI modules.

Note

Available only on Microchip PIC family devices. This macro will set data sampling for all SPI modules on MCU. Can be overwritten with fingerprint5_init which will set SET_SPI_DATA_SAMPLE_MIDDLE by default on the mapped mikrobus.

FINGERPRINT5_SET_DATA_SAMPLE_MIDDLE

#define FINGERPRINT5_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE

FINGERPRINT5_STATE_APP_FW_READY

#define FINGERPRINT5_STATE_APP_FW_READY   0x0001

Fingerprint 5 stete settings.

Specified setting for stete of Fingerprint 5 Click driver.

FINGERPRINT5_STATE_CAPTURE

#define FINGERPRINT5_STATE_CAPTURE   0x0004

FINGERPRINT5_STATE_DATA_TRANSFER

#define FINGERPRINT5_STATE_DATA_TRANSFER   0x0040

FINGERPRINT5_STATE_ENROLL

#define FINGERPRINT5_STATE_ENROLL   0x1000

FINGERPRINT5_STATE_FINGER_DOWN

#define FINGERPRINT5_STATE_FINGER_DOWN   0x0080

FINGERPRINT5_STATE_IDENTIFY

#define FINGERPRINT5_STATE_IDENTIFY   0x2000

FINGERPRINT5_STATE_IMAGE_AVAILABLE

#define FINGERPRINT5_STATE_IMAGE_AVAILABLE   0x0010

FINGERPRINT5_STATE_NAVIGATION

#define FINGERPRINT5_STATE_NAVIGATION   0x4000

FINGERPRINT5_STATE_SYS_ERROR

#define FINGERPRINT5_STATE_SYS_ERROR   0x0400

FINGERPRINT5_SYS_CFG_FLAG_STATUS_EVT_BOOT

#define FINGERPRINT5_SYS_CFG_FLAG_STATUS_EVT_BOOT   0x00000001

FINGERPRINT5_SYS_CFG_FLAG_UART_IN_STOP_MODE

#define FINGERPRINT5_SYS_CFG_FLAG_UART_IN_STOP_MODE   0x00000010

FINGERPRINT5_SYS_CFG_FLAG_UART_IRQ_TX

#define FINGERPRINT5_SYS_CFG_FLAG_UART_IRQ_TX   0x00000020

FINGERPRINT5_SYS_CFG_TYPE_CUSTOM

#define FINGERPRINT5_SYS_CFG_TYPE_CUSTOM   1

FINGERPRINT5_SYS_CFG_TYPE_DEFAULT

#define FINGERPRINT5_SYS_CFG_TYPE_DEFAULT   0

FINGERPRINT5_SYS_CFG_UART_BAUDRATE_115200

#define FINGERPRINT5_SYS_CFG_UART_BAUDRATE_115200   4

FINGERPRINT5_SYS_CFG_UART_BAUDRATE_19200

#define FINGERPRINT5_SYS_CFG_UART_BAUDRATE_19200   2

FINGERPRINT5_SYS_CFG_UART_BAUDRATE_57600

#define FINGERPRINT5_SYS_CFG_UART_BAUDRATE_57600   3

FINGERPRINT5_SYS_CFG_UART_BAUDRATE_921600

#define FINGERPRINT5_SYS_CFG_UART_BAUDRATE_921600   5

FINGERPRINT5_SYS_CFG_UART_BAUDRATE_9600

#define FINGERPRINT5_SYS_CFG_UART_BAUDRATE_9600   1

FINGERPRINT5_SYS_CFG_VERSION

#define FINGERPRINT5_SYS_CFG_VERSION   1

Fingerprint 5 system config settings.

Specified setting for system config of Fingerprint 5 Click driver.

FINGERPRINT5_TEMPLATE_ID_TYPE_ALL

#define FINGERPRINT5_TEMPLATE_ID_TYPE_ALL   0x2023

FINGERPRINT5_TEMPLATE_ID_TYPE_NEW

#define FINGERPRINT5_TEMPLATE_ID_TYPE_NEW   0x4045

FINGERPRINT5_TEMPLATE_ID_TYPE_NONE

#define FINGERPRINT5_TEMPLATE_ID_TYPE_NONE   0x1012

Fingerprint 5 template ID type settings.

Specified setting for template ID type of Fingerprint 5 Click driver.

FINGERPRINT5_TEMPLATE_ID_TYPE_SPECIFIED

#define FINGERPRINT5_TEMPLATE_ID_TYPE_SPECIFIED   0x3034

FINGERPRINT5_TX_DRV_BUFFER_SIZE

#define FINGERPRINT5_TX_DRV_BUFFER_SIZE   256

Fingerprint 5 driver buffer size.

Specified size of driver ring buffer.

Note

Increase buffer size if needed.